Operation Directory.Projection (Get a Directory Projection)

In component org.nuxeo.ecm.core.automation.features.operations

Description

Executes a query using given filter and return only the column *columnName*. The result is assigned to the context variable *variableName*. The filters are specified as key=value pairs separated by a new line. The key used for a filter is the column name of the directory. To specify multi-line values you can use a \ character followed by a new line.

Example:

firstName=John
lastName=doe

By default, the search filters use exact match. You can do a fulltext search on some specific columns using the fulltextFields. it's specified as comma separated columnName, for instance :

Example:

firstName,lastName

Operation id	Directory.Projection
Category	Services
Label	Get a Directory Projection
Requires
Since	5.7.2

Parameters

Name	Type	Required
columnName	string	yes
directoryName	string	yes
variableName	string	yes
filters	properties	no
fulltextFields	stringlist	no

Signature

Inputs	void
Outputs	void

Implementation Information

Implementation Class	Class: org.nuxeo.ecm.automation.core.operations.services.directory.DirectoryProjection
Contributing Component	org.nuxeo.ecm.core.automation.features.operations

JSON Definition

{
  "id" : "Directory.Projection",
  "label" : "Get a Directory Projection",
  "category" : "Services",
  "requires" : null,
  "description" : "Executes a query using given filter and return only the column *<b>columnName</b>*. The result is assigned to the context variable *<b>variableName</b>*. The filters are specified as <i>key=value</i> pairs separated by a new line. The key used for a filter is the column name of the directory. To specify multi-line values you can use a \\ character followed by a new line. <p>Example:<pre>firstName=John<br>lastName=doe</pre>By default, the search filters use exact match. You can do a fulltext search on some specific columns using the fulltextFields. it's specified as comma separated columnName, for instance : <p>Example:<pre>firstName,lastName</pre>",
  "since" : "5.7.2",
  "url" : "Directory.Projection",
  "signature" : [ "void", "void" ],
  "params" : [ {
    "name" : "columnName",
    "description" : null,
    "type" : "string",
    "required" : true,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "directoryName",
    "description" : null,
    "type" : "string",
    "required" : true,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "variableName",
    "description" : null,
    "type" : "string",
    "required" : true,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "filters",
    "description" : null,
    "type" : "properties",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "fulltextFields",
    "description" : null,
    "type" : "stringlist",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  } ]
}